Revert "Remove generic type from BaseApiClient"
#96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
llucax
added
the
scope:breaking-change
This change was intended to make building a client simpler, but it ended up being more complicated than expected, using the async stub is more complicated than expected, as it lives only in the `.pyi` file and can't be used in any other context than type hints. For example the new approach didn't worked well with delaying the connection of the client. To handle that correctly, more work is needed by subclasses. This commit reverts back to making the `BaseApiClient` class generic and it instantiates the stub internally as before. To get proper async type hints, users now only need to write the `stub` property themselves, and use the appropriate async stub type hint there. This reverts commit 035a794. Signed-off-by: Leandro Lucarella <[email protected]>
|
Example use: frequenz-floss/frequenz-client-microgrid-python#100 |
Marenz
approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change was intended to make building a client simpler, but it ended up being more complicated than expected, using the async stub is more complicated than expected, as it lives only in the
.pyifile and can't be used in any other context than type hints. For example the new approach didn't worked well with delaying the connection of the client. To handle that correctly, more work is needed by subclasses.This commit reverts to making the
BaseApiClientclass generic and it instantiates the stub internally as before. To get proper async type hints, users now only need to write thestubproperty themselves, and use the appropriate async stub type hint there.The release notes are also cleared up because we plan to release v0.8.0 after this is merged.
This commit reverts commit 035a794.